/*
 * Copyright (c) 2009 the original author or authors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.as3undohistory.manage
{
	import com.as3undohistory.register.IAccessorRegistration;
	
	/**
	 * Describes an object that can record the changes to one property of a specified
	 * object chronologically.
	 * @author Roland Zwaga
	 * 
	 */	
	public interface IPropertyValueStack
	{
		/**
		 * The object instance of which a property, specified by the accessorRegistration property, is being monitored 
		 * @return the object instance 
		 * 
		 */
		function get instance():Object;
		function set instance(value:Object):void;
		/**
		 * Describes which property will be monitored for changes and how these changes can be detected 
		 * @return 
		 * @see com.as3undohistory.register.IAccessorRegistration IAccessorRegistration
		 * 
		 */
		function get accessorRegistration():IAccessorRegistration;
		/**
		 * The number of changes that have been made to the property until this point in time. 
		 * @return 
		 * 
		 */
		function get count():uint;
		/**
		 * Returns the previous value of the specified property and deletes this value from the stack.
		 * @return 
		 * 
		 */
		function pop():*;
		/**
		 * Adds a new property value to the stack.  
		 * @param value
		 * 
		 */
		function push(value:*):void;
	}
}